<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: IdMapper.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.jibx;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.Map;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>import org.dellroad.stuff.java.IdGenerator;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import org.jibx.extras.IdDefRefMapperBase;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import org.jibx.runtime.IMarshallable;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import org.jibx.runtime.IMarshallingContext;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import org.jibx.runtime.JiBXException;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.jibx.runtime.impl.MarshallingContext;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>/**<a name="line.19"></a>
<span class="sourceLineNo">020</span> * JiBX Marshaller/Unmarshaller that assigns unique ID's to each object and<a name="line.20"></a>
<span class="sourceLineNo">021</span> * replaces duplicate appearances of the same object with an IDREF reference.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * This class allows for easy ID/IDREF handling for existing classes, with minimal<a name="line.24"></a>
<span class="sourceLineNo">025</span> * modifications to those classes and no custom (un)marshaller subclasses.<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;h3&gt;JiBX Mapping&lt;/h3&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Suppose you have a class {@code Person.java} with a single {@code name} property<a name="line.30"></a>
<span class="sourceLineNo">031</span> * and you want to add ID/IDREF support to it.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * First add the following two pseudo-bean property methods to the classes:<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> *  import org.dellroad.stuff.jibx.IdMapper;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> *  public class Person {<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> *      private String name;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> *      public String getName() {<a name="line.43"></a>
<span class="sourceLineNo">044</span> *          return this.name;<a name="line.44"></a>
<span class="sourceLineNo">045</span> *      }<a name="line.45"></a>
<span class="sourceLineNo">046</span> *      public void setName(String name) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> *          this.name = name;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *      }<a name="line.48"></a>
<span class="sourceLineNo">049</span> *<a name="line.49"></a>
<span class="sourceLineNo">050</span> *      &lt;b&gt;// JiBX methods<a name="line.50"></a>
<span class="sourceLineNo">051</span> *      private String getJiBXId() {<a name="line.51"></a>
<span class="sourceLineNo">052</span> *          return IdMapper.getId(this);<a name="line.52"></a>
<span class="sourceLineNo">053</span> *      }<a name="line.53"></a>
<span class="sourceLineNo">054</span> *      private void setJiBXId(String id) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> *          // do nothing<a name="line.55"></a>
<span class="sourceLineNo">056</span> *      }&lt;/b&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *  }<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Note: if you subclass {@code Person.java} from a different sub-package, you may need<a name="line.59"></a>
<span class="sourceLineNo">060</span> * to change the access privileges of those methods from {@code private} to {@code protected}.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;/p&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Next, define a concrete mapping for {@code Person.java} and add the {@code id} attribute:<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> *  &amp;lt;mapping name="Person" class="com.example.Person"&amp;gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> *      &lt;b&gt;&amp;lt;value name="id" style="attribute" ident="def"<a name="line.67"></a>
<span class="sourceLineNo">068</span> *        get-method="getJiBXId" set-method="setJiBXId"/&amp;gt;&lt;/b&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> *      &amp;lt;value name="name" field="name"/&amp;gt;<a name="line.69"></a>
<span class="sourceLineNo">070</span> *  &amp;lt;/mapping&amp;gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * &lt;/p&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span> *<a name="line.73"></a>
<span class="sourceLineNo">074</span> * &lt;p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Finally, use {@link IdMapper} as the custom marshaller and unmarshaller wherever a {@code Person} appears, e.g.:<a name="line.75"></a>
<span class="sourceLineNo">076</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.76"></a>
<span class="sourceLineNo">077</span> *  &amp;lt;mapping name="Company" class="com.example.Company"&amp;gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> *      &amp;lt;collection name="Employees" field="employees" create-type="java.util.ArrayList"&amp;gt;<a name="line.78"></a>
<span class="sourceLineNo">079</span> *          &amp;lt;structure name="Person" type="com.example.Person"<a name="line.79"></a>
<span class="sourceLineNo">080</span> *            &lt;b&gt;marshaller="org.dellroad.stuff.jibx.IdMapper"<a name="line.80"></a>
<span class="sourceLineNo">081</span> *            unmarshaller="org.dellroad.stuff.jibx.IdMapper"&lt;/b&gt;/&amp;gt;<a name="line.81"></a>
<span class="sourceLineNo">082</span> *      &amp;lt;/collection&amp;gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span> *      &amp;lt;structure name="EmployeeOfTheWeek"&amp;gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span> *          &amp;lt;structure name="Person" field="employeeOfTheWeek"<a name="line.84"></a>
<span class="sourceLineNo">085</span> *            &lt;b&gt;marshaller="org.dellroad.stuff.jibx.IdMapper"<a name="line.85"></a>
<span class="sourceLineNo">086</span> *            unmarshaller="org.dellroad.stuff.jibx.IdMapper"&lt;/b&gt;/&amp;gt;<a name="line.86"></a>
<span class="sourceLineNo">087</span> *      &amp;lt;/structure&amp;gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> *  &amp;lt;/mapping&amp;gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Note the {@code EmployeeOfTheWeek} "wrapper" element for the {@code employeeOfTheWeek} field; this is required<a name="line.90"></a>
<span class="sourceLineNo">091</span> * in order to use an XML name for this field other than {@code Person} (see limitations below).<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;/p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * &lt;p&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Now the first appearance of any {@code Person} will contain the full XML structure with an additional &lt;code&gt;id="..."&lt;/code&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span> * attribute, while all subsequent appearances will contain just a reference of the form &lt;code&gt;&amp;lt;Person idref="..."/&amp;gt;&lt;/code&gt;.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Conversely, when unmarshalled all {@code Person} XML elements that refer to the same original {@code Person} will<a name="line.97"></a>
<span class="sourceLineNo">098</span> * re-use the same unmarshalled {@code Person} object.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * &lt;/p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> *<a name="line.100"></a>
<span class="sourceLineNo">101</span> * &lt;p&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span> * So the resulting XML might look like:<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span> *  &amp;lt;Company&amp;gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span> *      &amp;lt;Employees&amp;gt;<a name="line.105"></a>
<span class="sourceLineNo">106</span> *          &amp;lt;Person id="N00001"&amp;gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> *              &amp;lt;name&amp;gt;Aardvark, Annie&amp;lt;/name&amp;gt;<a name="line.107"></a>
<span class="sourceLineNo">108</span> *          &amp;lt;/Person&amp;gt;<a name="line.108"></a>
<span class="sourceLineNo">109</span> *          &amp;lt;Person id="N00002"&amp;gt;<a name="line.109"></a>
<span class="sourceLineNo">110</span> *              &amp;lt;name&amp;gt;Appleby, Arnold&amp;lt;/name&amp;gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span> *          &amp;lt;/Person&amp;gt;<a name="line.111"></a>
<span class="sourceLineNo">112</span> *          ...<a name="line.112"></a>
<span class="sourceLineNo">113</span> *      &amp;lt;/Employees&amp;gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> *      &amp;lt;EmployeeOfTheWeek&amp;gt;<a name="line.114"></a>
<span class="sourceLineNo">115</span> *          &amp;lt;Person idref="N00001"/&amp;gt;<a name="line.115"></a>
<span class="sourceLineNo">116</span> *      &amp;lt;/EmployeeOfTheWeek&amp;gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> *  &amp;lt;/Company&amp;gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span> * &lt;/p&gt;<a name="line.119"></a>
<span class="sourceLineNo">120</span> *<a name="line.120"></a>
<span class="sourceLineNo">121</span> * &lt;h3&gt;Limitations&lt;/h3&gt;<a name="line.121"></a>
<span class="sourceLineNo">122</span> *<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;p&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span> * JiBX and this class impose some limitations:<a name="line.124"></a>
<span class="sourceLineNo">125</span> * &lt;ul&gt;<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;li&gt;JiBX marshalling must be performed within an invocation of {@link IdGenerator#run IdGenerator.run()}<a name="line.126"></a>
<span class="sourceLineNo">127</span> *      so that an {@link IdGenerator} is available to generate the unique IDs (when using Spring, consider using<a name="line.127"></a>
<span class="sourceLineNo">128</span> *      {@link IdMappingMarshaller}; otherwise, the {@link JiBXUtil} methods all satisfy this requirement).&lt;/li&gt;<a name="line.128"></a>
<span class="sourceLineNo">129</span> * &lt;li&gt;Classes that use ID/IDREF must have concrete JiBX mappings.&lt;/li&gt;<a name="line.129"></a>
<span class="sourceLineNo">130</span> * &lt;li&gt;All occurences of the class must use the XML element name of the concrete mapping, so the use of<a name="line.130"></a>
<span class="sourceLineNo">131</span> *      a "wrapper" element is required when a different element name is desired.&lt;/li&gt;<a name="line.131"></a>
<span class="sourceLineNo">132</span> * &lt;/ul&gt;<a name="line.132"></a>
<span class="sourceLineNo">133</span> *<a name="line.133"></a>
<span class="sourceLineNo">134</span> * &lt;h3&gt;A Simpler Approach&lt;/h3&gt;<a name="line.134"></a>
<span class="sourceLineNo">135</span> *<a name="line.135"></a>
<span class="sourceLineNo">136</span> * The above approach is useful when you don't want to keep track of which instance of an object will appear first<a name="line.136"></a>
<span class="sourceLineNo">137</span> * in the XML encoding: the first one will always fully define the object, while subsequent ones will just reference it.<a name="line.137"></a>
<span class="sourceLineNo">138</span> *<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span> * If this flexibility is not needed, i.e., if you can identify where in your mapping the first occurrence of an object<a name="line.140"></a>
<span class="sourceLineNo">141</span> * will appear, then the following simpler approach works without the above approach's limitations (other than requiring<a name="line.141"></a>
<span class="sourceLineNo">142</span> * that marshalling be peformed within an invocation of {@link IdGenerator#run IdGenerator.run()}):<a name="line.142"></a>
<span class="sourceLineNo">143</span> *<a name="line.143"></a>
<span class="sourceLineNo">144</span> * &lt;p&gt;<a name="line.144"></a>
<span class="sourceLineNo">145</span> * First, replace the &lt;code&gt;// do nothing&lt;/code&gt; in the example above with call to {@link IdMapper#setId IdMapper.setId()},<a name="line.145"></a>
<span class="sourceLineNo">146</span> * and add a custom deserializer delegating to {@link ParseUtil#deserializeReference ParseUtil.deserializeReference()} to<a name="line.146"></a>
<span class="sourceLineNo">147</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.147"></a>
<span class="sourceLineNo">148</span> *      private void setJiBXId(String id) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> *          IdMapper.setId(this, id);<a name="line.149"></a>
<span class="sourceLineNo">150</span> *      }<a name="line.150"></a>
<span class="sourceLineNo">151</span> *<a name="line.151"></a>
<span class="sourceLineNo">152</span> *      public static Employee deserializeEmployeeReference(String string) throws JiBXParseException {<a name="line.152"></a>
<span class="sourceLineNo">153</span> *          return ParseUtil.deserializeReference(string, Employee.class);<a name="line.153"></a>
<span class="sourceLineNo">154</span> *      }<a name="line.154"></a>
<span class="sourceLineNo">155</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.155"></a>
<span class="sourceLineNo">156</span> * &lt;/p&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span> *<a name="line.157"></a>
<span class="sourceLineNo">158</span> * &lt;p&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span> * Then, map the first occurrence of an object exactly as in the concrete mapping above, exposing the &lt;code&gt;JiBXId&lt;/code&gt; property.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * In all subsequent occurrences of the object, expose the reference to the object as a simple property using the custom<a name="line.160"></a>
<span class="sourceLineNo">161</span> * serializer/deserializer pair {@link ParseUtil#serializeReference ParseUtil.serializeReference()} and<a name="line.161"></a>
<span class="sourceLineNo">162</span> * {@code Employee.deserializeEmployeeReference()}.<a name="line.162"></a>
<span class="sourceLineNo">163</span> * &lt;/p&gt;<a name="line.163"></a>
<span class="sourceLineNo">164</span> *<a name="line.164"></a>
<span class="sourceLineNo">165</span> * &lt;p&gt;<a name="line.165"></a>
<span class="sourceLineNo">166</span> * For example, the following binding would yeild the same XML encoding as before:<a name="line.166"></a>
<span class="sourceLineNo">167</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.167"></a>
<span class="sourceLineNo">168</span> *  &amp;lt;mapping abstract="true" type-name="person" class="com.example.Person"&amp;gt;<a name="line.168"></a>
<span class="sourceLineNo">169</span> *      &lt;b&gt;&amp;lt;value name="id" style="attribute" get-method="getJiBXId" set-method="setJiBXId"/&amp;gt;&lt;/b&gt;<a name="line.169"></a>
<span class="sourceLineNo">170</span> *      &amp;lt;value name="name" field="name"/&amp;gt;<a name="line.170"></a>
<span class="sourceLineNo">171</span> *  &amp;lt;/mapping&amp;gt;<a name="line.171"></a>
<span class="sourceLineNo">172</span> *<a name="line.172"></a>
<span class="sourceLineNo">173</span> *  &amp;lt;mapping name="Company" class="com.example.Company"&amp;gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span> *      &amp;lt;collection name="Employees" field="employees" create-type="java.util.ArrayList"&amp;gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span> *          &amp;lt;structure name="Person" map-as="person"/&amp;gt;    &amp;lt;!-- first occurences of all these objects --&amp;gt;<a name="line.175"></a>
<span class="sourceLineNo">176</span> *      &amp;lt;/collection&amp;gt;<a name="line.176"></a>
<span class="sourceLineNo">177</span> *      &amp;lt;structure name="EmployeeOfTheWeek"&amp;gt;<a name="line.177"></a>
<span class="sourceLineNo">178</span> *          &amp;lt;structure name="Person"&amp;gt;<a name="line.178"></a>
<span class="sourceLineNo">179</span> *              &lt;b&gt;&amp;lt;value name="idref" style="attribute" field="employeeOfTheWeek"<a name="line.179"></a>
<span class="sourceLineNo">180</span> *                serializer="org.dellroad.stuff.jibx.ParseUtil.serializeReference"<a name="line.180"></a>
<span class="sourceLineNo">181</span> *                deserializer="com.example.Employee.deserializeEmployeeReference"&lt;/b&gt;/&amp;gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span> *          &amp;lt;/structure&amp;gt;<a name="line.182"></a>
<span class="sourceLineNo">183</span> *      &amp;lt;/structure&amp;gt;<a name="line.183"></a>
<span class="sourceLineNo">184</span> *  &amp;lt;/mapping&amp;gt;<a name="line.184"></a>
<span class="sourceLineNo">185</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.185"></a>
<span class="sourceLineNo">186</span> * &lt;/p&gt;<a name="line.186"></a>
<span class="sourceLineNo">187</span> *<a name="line.187"></a>
<span class="sourceLineNo">188</span> * &lt;p&gt;<a name="line.188"></a>
<span class="sourceLineNo">189</span> * If you want the reference to be optionally &lt;code&gt;null&lt;/code&gt;, then you'll also need to add a &lt;code&gt;test-method&lt;/code&gt;:<a name="line.189"></a>
<span class="sourceLineNo">190</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.190"></a>
<span class="sourceLineNo">191</span> *      &lt;b&gt;private boolean hasEmployeeOfTheWeek() {<a name="line.191"></a>
<span class="sourceLineNo">192</span> *          return this.getEmployeeOfTheWeek() != null;<a name="line.192"></a>
<span class="sourceLineNo">193</span> *      }&lt;/b&gt;<a name="line.193"></a>
<span class="sourceLineNo">194</span> *<a name="line.194"></a>
<span class="sourceLineNo">195</span> *      &amp;lt;structure name="EmployeeOfTheWeek" &lt;b&gt;usage="optional" test-method="hasEmployeeOfTheWeek"&lt;/b&gt;&amp;gt;<a name="line.195"></a>
<span class="sourceLineNo">196</span> *          &amp;lt;structure name="Person"&amp;gt;<a name="line.196"></a>
<span class="sourceLineNo">197</span> *              &amp;lt;value name="idref" style="attribute" field="employeeOfTheWeek"<a name="line.197"></a>
<span class="sourceLineNo">198</span> *                serializer="org.dellroad.stuff.jibx.ParseUtil.serializeReference"<a name="line.198"></a>
<span class="sourceLineNo">199</span> *                deserializer="com.example.Employee.deserializeEmployeeReference"/&amp;gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span> *          &amp;lt;/structure&amp;gt;<a name="line.200"></a>
<span class="sourceLineNo">201</span> *      &amp;lt;/structure&amp;gt;<a name="line.201"></a>
<span class="sourceLineNo">202</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.202"></a>
<span class="sourceLineNo">203</span> * This approach causes the whole &lt;code&gt;&amp;lt;EmployeeOfTheWeek&amp;gt;&lt;/code&gt; element to disappear when there is no<a name="line.203"></a>
<span class="sourceLineNo">204</span> * such employee. Alternately, you can avoid the need for the &lt;code&gt;test-method&lt;/code&gt; if you want to allow<a name="line.204"></a>
<span class="sourceLineNo">205</span> * just the attribute to disappear, or you could even change from &lt;code&gt;style="attribute"&lt;/code&gt; to &lt;code&gt;style="element"&lt;/code&gt;;<a name="line.205"></a>
<span class="sourceLineNo">206</span> * in both cases you would be making the reference itself optional instead of the containing element.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * &lt;/p&gt;<a name="line.207"></a>
<span class="sourceLineNo">208</span> *<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @see IdMappingMarshaller<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span>public class IdMapper extends IdDefRefMapperBase {<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span>    private final int index;<a name="line.213"></a>
<span class="sourceLineNo">214</span>    private final String name;<a name="line.214"></a>
<span class="sourceLineNo">215</span>    // This is here to work around bogus JiBX binding error<a name="line.215"></a>
<span class="sourceLineNo">216</span>    private IdMapper() {<a name="line.216"></a>
<span class="sourceLineNo">217</span>        super(null, 0, null);<a name="line.217"></a>
<span class="sourceLineNo">218</span>        throw new UnsupportedOperationException();<a name="line.218"></a>
<span class="sourceLineNo">219</span>    }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span>    public IdMapper(String uri, int index, String name, String className) {<a name="line.221"></a>
<span class="sourceLineNo">222</span>        super(uri, index, name);<a name="line.222"></a>
<span class="sourceLineNo">223</span>        this.index = index;<a name="line.223"></a>
<span class="sourceLineNo">224</span>        this.name = name;<a name="line.224"></a>
<span class="sourceLineNo">225</span>    }<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span>    /**<a name="line.227"></a>
<span class="sourceLineNo">228</span>     * Get the unique ID value for the given object.<a name="line.228"></a>
<span class="sourceLineNo">229</span>     *<a name="line.229"></a>
<span class="sourceLineNo">230</span>     * &lt;p&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * The implementation in {@link IdMapper} formats an ID of the form &lt;code&gt;N012345&lt;/code&gt;<a name="line.231"></a>
<span class="sourceLineNo">232</span>     * using the {@link IdGenerator} acquired from {@link IdGenerator#get}.<a name="line.232"></a>
<span class="sourceLineNo">233</span>     *<a name="line.233"></a>
<span class="sourceLineNo">234</span>     * @param obj any object<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * @return unique ID for the object<a name="line.235"></a>
<span class="sourceLineNo">236</span>     */<a name="line.236"></a>
<span class="sourceLineNo">237</span>    public static String getId(Object obj) {<a name="line.237"></a>
<span class="sourceLineNo">238</span>        return IdMapper.formatId(IdGenerator.get().getId(obj));<a name="line.238"></a>
<span class="sourceLineNo">239</span>    }<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span>    /**<a name="line.241"></a>
<span class="sourceLineNo">242</span>     * Set the unique ID value for the given object.<a name="line.242"></a>
<span class="sourceLineNo">243</span>     *<a name="line.243"></a>
<span class="sourceLineNo">244</span>     * &lt;p&gt;<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * The implementation in {@link IdMapper} expects an ID of the form &lt;code&gt;N012345&lt;/code&gt;,<a name="line.245"></a>
<span class="sourceLineNo">246</span>     * then associates the parsed {@code long} value with the given object<a name="line.246"></a>
<span class="sourceLineNo">247</span>     * using the {@link IdGenerator} acquired from {@link IdGenerator#get}.<a name="line.247"></a>
<span class="sourceLineNo">248</span>     *<a name="line.248"></a>
<span class="sourceLineNo">249</span>     * @param obj object to register<a name="line.249"></a>
<span class="sourceLineNo">250</span>     * @param idref string ID assigned to the object<a name="line.250"></a>
<span class="sourceLineNo">251</span>     * @throws IllegalArgumentException if {@code idref} is not of the form &lt;code&gt;N012345&lt;/code&gt;<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * @throws IllegalArgumentException if {@code idref} is already associated with a different object<a name="line.252"></a>
<span class="sourceLineNo">253</span>     */<a name="line.253"></a>
<span class="sourceLineNo">254</span>    public static void setId(Object obj, String idref) {<a name="line.254"></a>
<span class="sourceLineNo">255</span>        IdGenerator.get().setId(obj, IdMapper.parseId(idref));<a name="line.255"></a>
<span class="sourceLineNo">256</span>    }<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span>    /**<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * Format the unique ID.<a name="line.259"></a>
<span class="sourceLineNo">260</span>     *<a name="line.260"></a>
<span class="sourceLineNo">261</span>     * @param id ID value<a name="line.261"></a>
<span class="sourceLineNo">262</span>     * @return formatted idref<a name="line.262"></a>
<span class="sourceLineNo">263</span>     */<a name="line.263"></a>
<span class="sourceLineNo">264</span>    public static String formatId(long id) {<a name="line.264"></a>
<span class="sourceLineNo">265</span>        return String.format("N%05d", id);<a name="line.265"></a>
<span class="sourceLineNo">266</span>    }<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span>    /**<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * Parse the unique ID value assigned to the given object by {@link #getId getId()}.<a name="line.269"></a>
<span class="sourceLineNo">270</span>     *<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * @param idref ID value assigned to the object<a name="line.271"></a>
<span class="sourceLineNo">272</span>     * @return parse ID number<a name="line.272"></a>
<span class="sourceLineNo">273</span>     * @throws IllegalArgumentException if {@code idref} is not of the form &lt;code&gt;N012345&lt;/code&gt;<a name="line.273"></a>
<span class="sourceLineNo">274</span>     */<a name="line.274"></a>
<span class="sourceLineNo">275</span>    public static long parseId(String idref) {<a name="line.275"></a>
<span class="sourceLineNo">276</span>        if (idref == null || idref.length() == 0 || !idref.matches("N-?\\d+"))<a name="line.276"></a>
<span class="sourceLineNo">277</span>            throw new IllegalArgumentException("invalid id value `" + idref + "'");<a name="line.277"></a>
<span class="sourceLineNo">278</span>        try {<a name="line.278"></a>
<span class="sourceLineNo">279</span>            return Long.parseLong(idref.substring(1), 10);<a name="line.279"></a>
<span class="sourceLineNo">280</span>        } catch (NumberFormatException e) {<a name="line.280"></a>
<span class="sourceLineNo">281</span>            throw new IllegalArgumentException("invalid id value `" + idref + "'");<a name="line.281"></a>
<span class="sourceLineNo">282</span>        }<a name="line.282"></a>
<span class="sourceLineNo">283</span>    }<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span>    /**<a name="line.285"></a>
<span class="sourceLineNo">286</span>     * Get the unique ID for the given object. Delegates to {@link #getId getId()}.<a name="line.286"></a>
<span class="sourceLineNo">287</span>     */<a name="line.287"></a>
<span class="sourceLineNo">288</span>    @Override<a name="line.288"></a>
<span class="sourceLineNo">289</span>    protected String getIdValue(Object obj) {<a name="line.289"></a>
<span class="sourceLineNo">290</span>        return IdMapper.getId(obj);<a name="line.290"></a>
<span class="sourceLineNo">291</span>    }<a name="line.291"></a>
<span class="sourceLineNo">292</span><a name="line.292"></a>
<span class="sourceLineNo">293</span>    /**<a name="line.293"></a>
<span class="sourceLineNo">294</span>     * Get the ID reference attribute name. Default is &lt;code&gt;"idref"&lt;/code&gt;.<a name="line.294"></a>
<span class="sourceLineNo">295</span>     */<a name="line.295"></a>
<span class="sourceLineNo">296</span>    @Override<a name="line.296"></a>
<span class="sourceLineNo">297</span>    protected String getAttributeName() {<a name="line.297"></a>
<span class="sourceLineNo">298</span>        return "idref";<a name="line.298"></a>
<span class="sourceLineNo">299</span>    }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span>    /**<a name="line.301"></a>
<span class="sourceLineNo">302</span>     * Overrides superclass to use object equality instead of {@code Object.equals()} for sanity checking.<a name="line.302"></a>
<span class="sourceLineNo">303</span>     */<a name="line.303"></a>
<span class="sourceLineNo">304</span>    @Override<a name="line.304"></a>
<span class="sourceLineNo">305</span>    @SuppressWarnings("unchecked")<a name="line.305"></a>
<span class="sourceLineNo">306</span>    public void marshal(Object obj, IMarshallingContext ictx) throws JiBXException {<a name="line.306"></a>
<span class="sourceLineNo">307</span><a name="line.307"></a>
<span class="sourceLineNo">308</span>        // Sanity check<a name="line.308"></a>
<span class="sourceLineNo">309</span>        if (obj == null)<a name="line.309"></a>
<span class="sourceLineNo">310</span>            return;<a name="line.310"></a>
<span class="sourceLineNo">311</span>        if (!(ictx instanceof MarshallingContext))<a name="line.311"></a>
<span class="sourceLineNo">312</span>            throw new JiBXException("Invalid context type for marshaller");<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span>        // Check if ID already defined<a name="line.314"></a>
<span class="sourceLineNo">315</span>        MarshallingContext ctx = (MarshallingContext)ictx;<a name="line.315"></a>
<span class="sourceLineNo">316</span>        Map&lt;String, Object&gt; map = (Map&lt;String, Object&gt;)ctx.getIdMap();<a name="line.316"></a>
<span class="sourceLineNo">317</span>        String id = this.getIdValue(obj);<a name="line.317"></a>
<span class="sourceLineNo">318</span>        Object value = map.get(id);<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span>        // New object? Output normally<a name="line.320"></a>
<span class="sourceLineNo">321</span>        if (value == null) {<a name="line.321"></a>
<span class="sourceLineNo">322</span>            if (!(obj instanceof IMarshallable))<a name="line.322"></a>
<span class="sourceLineNo">323</span>                throw new JiBXException("instance of " + obj.getClass() + " is not marshallable");<a name="line.323"></a>
<span class="sourceLineNo">324</span>            map.put(id, obj);<a name="line.324"></a>
<span class="sourceLineNo">325</span>            ((IMarshallable)obj).marshal(ctx);<a name="line.325"></a>
<span class="sourceLineNo">326</span>            return;<a name="line.326"></a>
<span class="sourceLineNo">327</span>        }<a name="line.327"></a>
<span class="sourceLineNo">328</span><a name="line.328"></a>
<span class="sourceLineNo">329</span>        // Sanity check what we got<a name="line.329"></a>
<span class="sourceLineNo">330</span>        if (value != obj)<a name="line.330"></a>
<span class="sourceLineNo">331</span>            throw new JiBXException("encountered two objects with the same ID " + id);<a name="line.331"></a>
<span class="sourceLineNo">332</span><a name="line.332"></a>
<span class="sourceLineNo">333</span>        // Emit a reference<a name="line.333"></a>
<span class="sourceLineNo">334</span>        ctx.startTagAttributes(this.index, this.name);<a name="line.334"></a>
<span class="sourceLineNo">335</span>        ctx.attribute(0, this.getAttributeName(), id);<a name="line.335"></a>
<span class="sourceLineNo">336</span>        ctx.closeStartEmpty();<a name="line.336"></a>
<span class="sourceLineNo">337</span>    }<a name="line.337"></a>
<span class="sourceLineNo">338</span>}<a name="line.338"></a>
<span class="sourceLineNo">339</span><a name="line.339"></a>




























































</pre>
</div>
</body>
</html>
